Skip to content

docs: Models > Records — Reporting, Monitoring, Attestation#1359

Merged
validbeck merged 15 commits into
mainfrom
beck/sc-15995/documentation-primary-record-types-phase
Jun 2, 2026
Merged

docs: Models > Records — Reporting, Monitoring, Attestation#1359
validbeck merged 15 commits into
mainfrom
beck/sc-15995/documentation-primary-record-types-phase

Conversation

@validbeck
Copy link
Copy Markdown
Collaborator

@validbeck validbeck commented May 28, 2026 •
edited
Loading

Pull Request Description

What and why?

sc-15995

Important

THIS PR IS NOT EXHAUSTIVE DUE TO THE LARGE SCOPE OF WORK. Refer to "What needs special review?" for follow-on updates.

How to test

Click on the live previews and verify everything looks OK:

Reporting

OLD NEW
Working with analytics Working with analytics
View report data View report data
Export analytics Export analytics
Generating exports Generating exports
Export inventory Export inventory
Export documents Export documents
Export artifacts Export artifacts

Monitoring

OLD NEW
Ongoing monitoring Ongoing monitoring
Enable monitoring Enable monitoring
Review monitoring results Review monitoring results
Work with metrics over time Work with metrics over time
Set thresholds and alerts Set thresholds and alerts

Attestation

OLD NEW
Working with attestations Working with attestations
Manage attestations Manage attestations
Submit attestations Submit attestations
Review attestations Review attestations
Approve attestations Approve attestations

Training — Adminstrator Fundamentals

OLD NEW
Onboarding Your Organization Onboarding Your Organization
Customizing Your Inventory Customizing Your Inventory
Using ValidMind for Risk Management Using ValidMind for Risk Management
Organizational Oversight & Reporting Organizational Oversight & Reporting

What needs special review?

Still one more update that needs to be made to the docs as this new functionality is pretty all-encompassing.

What's not covered and will be in a future Story (not using the sc link so the GitHub integration doesn't think these Stories are under review due to this PR being linked):

Dependencies, breaking changes, and deployment notes

n/a

Release notes

n/a

Checklist

  • What and why
  • Screenshots or videos (Frontend)
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied
  • PR linked to Shortcut
  • Unit tests added (Backend)
  • Tested locally
  • Documentation updated (if required)
  • Environment variable additions/changes documented (if required)

@validbeck validbeck self-assigned this May 28, 2026
@validbeck validbeck added the internal Not to be externalized in the release notes label May 28, 2026
@validbeck validbeck requested review from even-steven and jamadriz May 28, 2026 20:02
jamadriz
jamadriz requested changes Jun 1, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@jamadriz jamadriz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

refer to comments, other minor general:

"The PR updates visualization dataset names to Inventory Records and Artifact - Limitations, but configure-analytics-exports.qmd (Integrations) still lists Inventory Models and Artifact - Model Limitation. Fine for this PR given stated scope, but users cross-referencing reporting vs integrations may notice. Track for the follow-on story."

Comment thread site/guide/attestation/_configure-attestations.qmd
Comment thread site/guide/monitoring/ongoing-monitoring.qmd Outdated
Comment thread site/guide/attestation/approve-attestations.qmd Outdated
Comment thread site/guide/monitoring/ongoing-monitoring.qmd Outdated
@validbeck validbeck requested a review from jamadriz June 1, 2026 23:46
@validbeck
Copy link
Copy Markdown
Collaborator Author

validbeck commented Jun 2, 2026

"The PR updates visualization dataset names to Inventory Records and Artifact - Limitations, but configure-analytics-exports.qmd (Integrations) still lists Inventory Models and Artifact - Model Limitation. Fine for this PR given stated scope, but users cross-referencing reporting vs integrations may notice. Track for the follow-on story."

Yes, this is covered in the Integrations work outside of the scope of this Story; can you approve so I can wrap this into the release notes deploy? 🙏🏻

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 2, 2026

PR Summary

This pull request updates the documentation and training materials to reflect a shift in terminology from "model" to "record". The changes impact several guides including attestation, monitoring, reporting, workflows, and AI governance. Key modifications include:

  • Replacing references that previously described attestation processes related to models so that they now reference records (or model records) throughout. This includes minor text adjustments in instructions, UI labels, and tooltips.
  • Updating stakeholder delineation, form labels, and inventory-related verbiage to ensure consistency in how records are referenced compared to the old model-centric language.
  • Revising training modules and administrator guides to align terminology with current usage, ensuring that both the product interface and sound documentation use the same terminology consistently.

Overall, the PR is focused on clarifying and harmonizing the language used across the documentation by making sure that textual references align with the updated product concepts. These changes do not impact any functional business logic or code execution.

Test Suggestions

  • Manually review a sample of pages (e.g., attestation guides, monitoring documents, and reporting guides) to ensure that all instances of 'model' are correctly replaced with 'record' where appropriate.
  • Verify that UI elements and help text in the product interface match the new documentation terminology.
  • Run automated content validation checks to catch any missed instances of the old terminology or formatting inconsistencies.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 2, 2026

Validate docs site

✓ INFO: A live preview of the docs site is available — Open the preview

@validbeck validbeck merged commit dabc6da into main Jun 2, 2026
6 of 7 checks passed
@validbeck validbeck deleted the beck/sc-15995/documentation-primary-record-types-phase branch June 2, 2026 18:02
@validbeck validbeck mentioned this pull request Jun 2, 2026
Merged
11 tasks
validbeck added a commit that referenced this pull request Jun 2, 2026
@validbeck @github-actions @nrichers
Deploy release notes 26.06 (#1365)
f03e3ed 
* Merge pull request #1359 from validmind/beck/sc-15995/documentation-primary-record-types-phase

docs: Models  > Records — Reporting, Monitoring, Attestation

* Preview for 26.06 release notes + `make get-source` (#1353)

* Add temporary release-notes branch ref for 26.06 preview

Points to nrichers/sc-16263/release-notes-for-26-06 branch in release-notes repo.

* Run make get-source

* Add subtitle to all-releases page listing

* refreshing vm-library

* cache invalidation

* Update .github/workflows/validate-docs-site.yaml

Co-authored-by: Nik Richers <nik@validmind.ai>

* REF FOR PREVIEW, REMOVE BEFORE MERGE

* Update .github/workflows/validate-docs-site.yaml

---------

Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Nik Richers <nrichers@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jamadriz jamadriz jamadriz approved these changes

@even-steven even-steven Awaiting requested review from even-steven

Assignees

@validbeck validbeck

Labels

internal Not to be externalized in the release notes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@validbeck @jamadriz